Skip to content

Conversation

greg-fer
Copy link
Contributor

Updated documentation with information about nRFVSC being available on the Open VSIX Registry website. Edited how nRFVSC is referred to in the docs. VSC-3067.

@greg-fer greg-fer added this to the 3.2.0-preview1 milestone Aug 15, 2025
@greg-fer greg-fer added CI-disable Disable CI for this PR doc only labels Aug 15, 2025
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Aug 15, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Aug 15, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 6

Inputs:

Sources:

more details

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests

Note: This message is automatically posted and updated by the CI

Copy link

github-actions bot commented Aug 15, 2025

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/building.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/cmake/index.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/config_and_build_system.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/hardware/add_new_led_example.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/hardware/index.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/kconfig/index.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/create_application.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/custom/defining_custom_board.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/fem/21540ek_dev_guide.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/fem/2220ek_dev_guide.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf53/building_nrf53.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_flpr.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_logging.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ppr.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf54l/building_nrf54l.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf70/nrf7002eb2_dev_guide.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf70/nrf7002eb_dev_guide.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf70/nrf7002ek_dev_guide.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/nrf91/nrf91_snippet.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/thingy53/building_thingy53.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/device_guides/thingy91/thingy91_building_programming.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/app_dev/programming.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/dev_model_and_contributions/adding_code.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/dev_model_and_contributions/managing_code.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/external_comp/edge_impulse.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/glossary.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/installation/install_ncs.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/installation/recommended_versions.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/installation/updating.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/libraries/bin/lwm2m_carrier/app_integration.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/libraries/debug/cpu_load.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/libraries/modem/lte_lc.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/libraries/networking/nrf_cloud.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/releases_and_maturity/releases/release-notes-2.8.0-preview1.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/releases_and_maturity/releases/release-notes-2.8.0.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/releases_and_maturity/releases/release-notes-changelog.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/samples/matter.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/test_and_optimize.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/test_and_optimize/debugging.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/ipc_radio/README.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/nrf5340_audio/doc/building.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/nrf5340_audio/doc/configuration.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/nrf_desktop/board_configuration.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/nrf_desktop/description.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/nrf_desktop/memory_layout.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/serial_lte_modem/doc/CARRIER_AT_commands.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/applications/serial_lte_modem/doc/slm_description.html
doc/nrf/samples/matter.rst
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/samples/bluetooth/peripheral_mds/README.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/samples/cellular/nrf_cloud_multi_service/README.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/samples/ipc/ipc_service/README.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/samples/matter/smoke_co_alarm/README.html
https://ncsdoc.z6.web.core.windows.net/PR-24018/nrf/samples/matter/temperature_sensor/README.html

@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 22, 2025
@greg-fer greg-fer marked this pull request as ready for review August 22, 2025 11:13
@greg-fer greg-fer requested review from a team, FrancescoSer and annwoj as code owners August 22, 2025 11:13
@greg-fer greg-fer requested review from b-gent and umapraseeda August 22, 2025 11:13
@@ -1692,6 +1692,8 @@

.. ### Source: other (2 links or less from the same URL)

.. _`Open VSIX Registry`: https://open-vsx.org/
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The website itself spells it: Open VSX Registry

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right -.- Thanks

.. note::
You can also use a different IDE compatible with the VSIX format and install the extensions that are part of the nRF Connect for VS Code Extension Pack from the `Open VSIX Registry`_.
However, the extensions are only recommended and tested for use with |VSC|.
Extension issues discovered in IDEs other than |VSC| will not be prioritized.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use same wording as before ... not reproducible on VSC IDE....

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While you are encouraged to report any issues you encounter on DevZone_, issues discovered in editors other than |VSC| and not reproducible in |VSC| will not be prioritized.

@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 22, 2025
@greg-fer greg-fer changed the title doc: install_ncs: nRFVSC on Open VSIX Registry doc: install_ncs: nRFVSC on Open VSX Registry Aug 22, 2025
@@ -71,7 +71,7 @@ Use one of the following methods:

.. group-tab:: nRF Connect for Visual Studio Code
Copy link
Contributor

@peknis peknis Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other group-tabs you have nRF Connect for VS Code. Maybe just for consistency, have it like that also here.
Also wondering whether the shortcut would work in group-tabs.

Copy link
Contributor Author

@greg-fer greg-fer Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't look into shortcut, as it is not really something for this PR.

Updated documentation with information about nRFVSC being available
on the Open VSX Registry website. Edited how nRFVSC is referred to
in the docs. VSC-3067.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@@ -33,7 +33,7 @@ For example, if you build for nRF52840 DK on the command line, you can use the f
west build -b nrf52840dk/nrf52840 -- -DSHIELD=nrf21540ek
If you use the |nRFVSC|, specify ``-DSHIELD=nrf21540ek`` in the **Extra Cmake arguments** field when `setting up a build configuration <How to work with build configurations_>`_.
If you use |nRFVSC|, specify ``-DSHIELD=nrf21540ek`` in the **Extra Cmake arguments** field when `setting up a build configuration <How to work with build configurations_>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you fix the typo in line 69 : In this command, the ipc_radio image us used as default and builds the network core image with support for the combination of 802.15.4 and Bluetooth.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in a separate commit.

Fixed typos and style in 21540ek_dev_guide.rst.
NCSDK-NONE.
Requested by @umapraseeda.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer greg-fer added backport v3.1-branch and removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Aug 27, 2025
@nordicjm nordicjm merged commit 621627e into nrfconnect:main Aug 27, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport v3.1-branch CI-disable Disable CI for this PR doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.